Moving lots of options
authorparkrrrr <parkrrrr>
Fri, 19 May 2006 05:49:07 +0000 (05:49 +0000)
committerparkrrrr <parkrrrr>
Fri, 19 May 2006 05:49:07 +0000 (05:49 +0000)
31 files changed:
xmldoc/filters/discard.xml
xmldoc/filters/nuketypes.xml
xmldoc/filters/options/discard-hdop.xml
xmldoc/filters/options/discard-hdopandvdop.xml
xmldoc/filters/options/discard-vdop.xml
xmldoc/filters/options/nuketypes-routes.xml
xmldoc/filters/options/nuketypes-tracks.xml
xmldoc/filters/options/nuketypes-waypoints.xml
xmldoc/filters/options/polygon-exclude.xml
xmldoc/filters/options/polygon-file.xml
xmldoc/filters/options/position-all.xml
xmldoc/filters/options/position-distance.xml
xmldoc/filters/options/sort-description.xml
xmldoc/filters/options/sort-gcid.xml
xmldoc/filters/options/sort-shortname.xml
xmldoc/filters/options/sort-time.xml
xmldoc/filters/options/track-course.xml
xmldoc/filters/options/track-fix.xml
xmldoc/filters/options/track-merge.xml
xmldoc/filters/options/track-move.xml
xmldoc/filters/options/track-pack.xml
xmldoc/filters/options/track-speed.xml
xmldoc/filters/options/track-split.xml
xmldoc/filters/options/track-start.xml
xmldoc/filters/options/track-stop.xml
xmldoc/filters/options/track-title.xml
xmldoc/filters/polygon.xml
xmldoc/filters/position.xml
xmldoc/filters/sort.xml
xmldoc/filters/track.xml
xmldoc/formats/options/an1-road.xml

index 232e2ea1dd71226f3c50f28a2226f77a4efd2d1e..962549f652e59567abdd51cff4cb08af595c0fe8 100644 (file)
@@ -1,28 +1,12 @@
-
-         
-         <para> This filter 'fixes' gps data by discarding points with
-         a hdop and/or vdop over a set limit. If you give both the
-         hdop and a vdop options, by default points that exceed EITHER
-         are discarded (OR). This filter processes waypoints, tracks,
-         and routes.
+<para>
+This filter is used to "fix" unreliable GPS data by discarding points
+with HDOP and/or VDOP above a specified limit.  HDOP and VDOP are 
+measures of the best possible horizontal or vertical precision 
+for a given configuration of GPS satellites.
 </para>
-         <para>HDOP (float)</para>
-         <para>Points with a hdop exceeding the given value are
-         discarded.
-</para>
-         <para>VDOP (float)</para>
-         <para>Points with a vdop exceeding the given value are
-         discarded.</para>
-         <para>HDOPANDVDOP</para>
-         <para>Only useful if both hdop and vdop are given. Now
-         logical AND is used, i.e. only points exceeding both given
-         values are discarded.
-</para>
-         <para>            Example: </para>
-         <screen format="linespecific"> gpsbabel \ 
-       -i gpx -f in.gpx \
-       -x discard,hdop=10,vdop=20,hdopandvdop \ 
-       -o gpx -F out.gpx
-</screen>
-         <para> Contributed by Tobias Minich.</para>
+<example id="example_discard_filter">
+<title>Using the discard filter</title>
+<screen format="linespecific"> gpsbabel -i gpx -f in.gpx -x discard,hdop=10,vdop=20,hdopandvdop -o gpx -F out.gpx</screen>
+</example>
+<para> Contributed by Tobias Minich.</para>
       
index 9f8c4569d8f1325cadf64b4d30eaf67fcfbdd7aa..c0a26c40a3b37ab2e9c42258ee9915e07d1253b5 100644 (file)
@@ -1,18 +1,16 @@
+<para>
+There are three main types of data that GPSBabel deals with:
+waypoints, tracks, and routes.   The nuketypes filter allows
+removing all the data of any or all of those three types.
+</para>
+<example id="example_nuketypes_filter">
+<title>Filtering data types with nuketypes</title>
+<para>
+If you have a GPX file that contains routes, tracks, and
+waypoints and you want a GPX file that contains only tracks,
+you may use this filter to remove the waypoints with this command:
+</para>
+<screen format="linespecific">gpsbabel -i gpx -f bigfile.gpx -x nuketypes,waypoints,routes -o gpx -F tracksonly.gpx</screen>
+</example>
 
-         
-       <para>
-       There are three main types of data that GPSBabel deals with:
-       waypoints, tracks, and routes.   The nuketypes filter allows
-       removing all the data of any or all of those three types.
-       </para>
-       <para><option>waypoints</option> - Removes all waypoints.</para>
-       <para><option>tracks</option> - Removes all routes.</para>
-       <para><option>routes</option> - Removes all routes.</para>
-       <para>
-       For example, if you have a GPX file that contains routes, tracks, and
-       waypoints and you want a GPX file that contains only tracks,
-       you can use this filter to remove the waypoints with this command:
-       </para>
-        <screen format="linespecific">gpsbabel -i gpx -f bigfile.gpx -x nuketypes,waypoints,routes -o gpx -F tracksonly.gpx
-       </screen>
       
index 8b137891791fe96927ad78e64b0aad7bded08bdc..8fcc16080c2421b57666c58d6039d8b33c557b2a 100644 (file)
@@ -1 +1,7 @@
+<para>
+This option specifies the maximum allowable Horizontal Dilution of 
+Precision (HDOP).  By default, any point with an HDOP in excess of 
+this value will be discarded regardless of its VDOP, but see 
+<option>hdopandvdop</option>.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..d07dd4144db0c71a48953143269ef310478452fd 100644 (file)
@@ -1 +1,6 @@
-
+<para>
+If this option is used, only points that exceed both the maximum 
+allowable HDOP and the maximum allowable VDOP will be discarded.  This
+option requires that both the <option>hdop</option> and 
+<option>vdop</option> options be specified.  
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f8701abd8920f34e4910ccdc1f5fee50072b377c 100644 (file)
@@ -1 +1,7 @@
+<para>
+This option specifies the maximum allowable Vertical Dilution of 
+Precision (VDOP).  By default, any point with an VDOP in excess of 
+this value will be discarded regardless of its HDOP, but see 
+<option>hdopandvdop</option>.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..9c70b59bae4417ab6b7bc2f23f258176dd82dbe4 100644 (file)
@@ -1 +1,4 @@
+<para>
+This option causes the nuketypes filter to discard all route data.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..536c9d6cc4b800ba2d99fa039737ea41d0df6de0 100644 (file)
@@ -1 +1,4 @@
+<para>
+This option causes the nuketypes filter to discard all track data.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..26c71901e8ff8975dd74d6c9e8bf55ce981f357a 100644 (file)
@@ -1 +1,5 @@
+<para>
+This option causes the nuketypes filter to discard all waypoints that are not 
+associated with a track or route.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..6a68bdfa20366f455796cf155ec55f7d28666fc4 100644 (file)
@@ -1 +1,6 @@
+<para>
+When this option is specified, the usual sense of the polygon filter is 
+reversed.   That is, points that are inside the polygon are discarded
+while points that are further away are kept.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..032b595c1e2ec4fa2aceaa1c95de7f59deaee8b4 100644 (file)
@@ -1 +1,16 @@
+<para>
+This option is required.
+</para>
+<para>
+This option specifies the name of the file containing the polygon to use for
+filtering.  The format of the file is as described above.
+</para>
+<para>
+GPSBabel supports converting any route or track to a file usable by this
+filter; simply read it in the normal way and write it using the 
+<link linkend="fmt_arc">arc</link> file format.  Afterward, you will 
+need to make sure that the first point and the last point in the 
+file are the same, as the polygon filter depends on that.  You can do so
+with any text editor.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..16e59e5a8a4414c705607dde292491342459b802 100644 (file)
@@ -1 +1,8 @@
+<para>
+This option causes the position filter to remove all points that are within
+the specified distance of one another, rather than leaving just one of them.
+</para>
+<para>
+This option may be used to entirely remove clusters of points.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..ebd18d5d9ca3c2a59ca9dc0e00cb5db4c90fb5d6 100644 (file)
@@ -1 +1,9 @@
+<para>
+This option specifies the minimum allowable distance between two points.  If 
+two points are closer than this distance, only one of them is kept.
+</para>
+<para>
+Distances may be expressed in feet (30f) or meters (10m).  If no unit is 
+specified, the distance is assumed to be in feet.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..c629fce01657d39d7f1eb9e1fd85ab737c7f9dbf 100644 (file)
@@ -1 +1,8 @@
+<para>
+This option causes the waypoints to be sorted in alphabetical order by 
+description.
+</para>
+<para>
+This option is not valid in combination with any other option.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..c2431b77880035bdb7b1cc5817ef1864d036d27e 100644 (file)
@@ -1 +1,8 @@
+<para>
+If the data contains Groundspeak geocache IDs, this option causes the 
+waypoints to be sorted in alphabetical order by geocache ID.
+</para>
+<para>
+This option is not valid in combination with any other option.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..cd4075ccb7108dbe5cee78b65329f9e95a509a26 100644 (file)
@@ -1 +1,8 @@
+<para>
+This option causes the waypoints to be sorted in alphabetical order by 
+short name.
+</para>
+<para>
+This option is not valid in combination with any other option.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..c43f609028e321b8255a1484ddb59d6102418631 100644 (file)
@@ -1 +1,8 @@
+<para>
+This option causes the waypoints to be sorted in chronological order by 
+creation time.
+</para>
+<para>
+This option is not valid in combination with any other option.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..36b83f29ad8b538a424639110bf16eea83e5e35f 100644 (file)
@@ -1 +1,10 @@
+<para>
+This option computes (or recomputes) a value for the GPS heading at each 
+trackpoint.  This is most useful with trackpoints from formats that don't 
+support heading information or for trackpoints synthesized by the 
+<link linkend="filter_interpolate">interpolate</link>
+filter.  The heading at each trackpoint is simply the course from the
+previous trackpoint in the track.  The first trackpoint in each track
+is arbitrarily assigned a heading of 0 degrees.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..4cd9f303af5d21599f8b2cd2babd5527db51f228 100644 (file)
@@ -1 +1,9 @@
+<para>
+This option sets the GPS fix status for all trackpoints to the specified
+value.  Valid values for this option are PPS, DGPS, 3D, 2D, or NONE.
+</para>
+<para>
+This option is most useful when converting from a format that doesn't 
+contain GPS fix status to one that requires it.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..5ca5bbbf9794b42ce795b36e3f737095c58b6abc 100644 (file)
@@ -1 +1,14 @@
+<para> 
+This option puts all track points from all tracks into a single track 
+and sorts them by time stamp.  Points with identical time stamps will be
+dropped.
+</para>
+<example id="ex_track_merge">
+<title>Merging tracks with the track filter</title>
+<para> 
+Suppose you want to merge tracks recorded with two different GPS devices 
+at the same time.  To do that, use this command line:
+</para>
+<screen format="linespecific">gpsbabel -t -i gpx -f john.gpx -i gpx -f doe.gpx -x track,merge,title="COMBINED LOG" -o gpx -F john_doe.gpx</screen>
+</example>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..0641de1e9f4113d606654b128e3489228733b52f 100644 (file)
@@ -1 +1,13 @@
+<para>
+This option changes the time of all trackpoints. This might be useful if
+your track must be moved by one or more hours because of an incorrect
+time zone.
+</para>
+<example id="ex_track_move">
+<title>Time-shifting a track with the track filter</title>
+<para>
+The following command line will shift all tracks to be one hour later.
+</para>
+<screen format="linespecific">gpsbabel -t -i gpx -f in.gpx -x track,move=+1h -o gpx -F out.gpx</screen>
+</example>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..c65f6893f2f0e389caf4b7a65e1e7e1473cc3532 100644 (file)
@@ -1 +1,12 @@
-
+<para> 
+This option causes all tracks to be appended to one another to form a single
+track.  This option does not work if any two tracks overlap in time; in that
+case, consider using the <option>merge</option> option. 
+</para>
+<para>
+This option is most useful for rejoining tracks that might have
+been interrupted by an equipment malfunction or an overnight stop.
+</para>
+<para>
+If no other option is given to the track filter, this option is assumed.
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..32d640bdf83382a6f8024f20817628b5ed530e93 100644 (file)
@@ -1 +1,9 @@
-
+<para>
+This option computes a value for the GPS speed at each trackpoint.
+This is most useful with trackpoints from formats that don't support
+speed information or for trackoints synthesized by the 
+<link linkend="filter_interpolate">interpolate</link>
+filter.  The speed at each trackpoint is the average speed from the
+previous trackpoint (distance divided by time).  The first trackpoint 
+in each track is assigned a speed of "unknown."
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..6db49a7908af520c9a2a6261efa0ceb6bca9ca97 100644 (file)
@@ -1 +1,123 @@
 
+         
+         <para> ( !!! This filter always drops empty tracks !!! )
+         </para>
+         <para>The track filter is a tool for manipulating track lists.  The
+following options are available:</para>
+         <para> TITLE</para>
+         <para> Gives the new track(s) a basic title. Basic means if
+         more than one track is created by filter the title will be
+         expanded with the date the new track. Special formats (see
+         UNIX date or strftime for details) are possible.
+</para>
+         <screen format="linespecific">
+gpsbabel -t \
+ -i gpx -f in.gpx \ -x track,pack,split,title="ACTIVE LOG-%D" \ 
+-o gpx -F out.gpx PACK
+       </screen>
+         <para>MOVE</para>
+         <para>Change the time of all trackpoints. This is useful if
+         your track has moved by one or more hours through a time zone
+         problem.  The following example will shift your track to be
+         one hour later.</para>
+         <screen format="linespecific">            
+gpsbabel -t  -i gpx -f in.gpx  \
+    -x track,move=+1h,pack,title="ACTIVE LOG"  \
+    -o gpx -F out.gpx  </screen>
+         <para> START / STOP </para>
+         <para>Filter tracks against time borders. All points outside
+         this range will be dropped. The date-time paramters have to
+         be in form of YYYYMMDDHHMMSS; but you may specify only the
+         most significant portion represented in the the leftmost
+         fields.  See the example, where the time is specified only
+         through the hour.  If you only want to get a track mapped on
+         20 july 2005 from 10 am to 6pm, you should use this: </para>
+         <screen format="linespecific">
+gpsbabel -t -i gpx -f in.gpx -x \
+      track,start=2005072010,stop=2005072018 \
+      -o gpx -F out.gpx </screen>
+         <para>PACK</para>
+         <para> With this default option all tracks from input will be
+         packed into one track. If tracks overlaps in time, the filter
+         stops working.  To pack all the tracks together into one
+         track and give it a name, use this:</para>
+         <screen format="linespecific">            
+gpsbabel -t  -i gpx -f in.gpx          -x track,pack,title="ACTIVE LOG"  \
+                    -o gpx -F out.gpx  </screen>
+         <para>SPLIT </para>
+         <para> The input track will be split into several tracks
+         depending on date of track points. If there is more than one
+         track, use the pack option before before using this.  To
+         split a single tracks into separate tracks for each day and
+         name them, use this:
+      </para>
+         <screen format="linespecific">
+gpsbabel -t -i gpx -f in.gpx -x \
+   track,split,title="ACTIVE LOG \
+    # %Y%m%d" -o gpx -F out.gpx</screen>
+         <para> If the input has multiple tracks, pack them together before
+splitting them back apart per day thusly: </para>
+         <screen format="linespecific">            
+gpsbabel -t   -i gpx -f in.gpx  \
+     -x track,pack,split,title="ACTIVE LOG # %D"       \
+     -o gpx -F out.gpx</screen>
+         <para> Additionally you can add an interval to the split
+         option.  With this the track will be split if the time
+         between two points is greater than this parameter. The
+         interval must be numeric and can be int days, hours, minutes
+         or seconds, expressed as one of the character "d", "h", "m",
+         or "s".  If no trailing character is present, the units are
+         assumed to be in seconds.
+</para>
+         <para> For example, to split a track based on an four hour
+         interval, use this:</para>
+         <screen format="linespecific">            
+gpsbabel -t \ 
+     -i gpx -f in.gpx \ 
+     -x track,pack,split=4h,title="LOG # %c" \ 
+     -o gpx -F out.gpx
+</screen>
+         <para> MERGE</para>
+         <para> Merge puts all track points into one single track and
+         sort them by time. Points with identical time stamp will be
+         dropped !!!</para>
+         <para> If you want to merge tracks from different devices but
+         from same trip, use this:</para>
+         <screen format="linespecific">
+gpsbabel -t \
+     -i gpx -f john.gpx \
+     -i gpx -f doe.gpx \
+     -x track,merge,title="COMBINED LOG" \
+     -o gpx -F john_doe.gpx
+</screen>
+       <para>FIX</para>
+       <para>Fix forces the GPS fix status for all trackpoints to the 
+        specified value.  The value may be PPS, DGPS, 3D, 2D, or NONE.
+       </para>
+       <screen format="linespecific">
+       gpsbabel -i gpx -f trk.gpx -x track,fix=3D -o nmea -F -
+       </screen>
+
+       <para>COURSE</para>
+       <para>Course computes a value for the GPS heading at each trackpoint.
+       This is most useful with trackpoints from formats that don't support
+       heading information or for trackpoints synthesized by the interpolate
+       filter.  The heading at each trackpoint is simply the course from the
+       previous trackpoint in the track.  The first trackpoint in each track
+        is arbitrarily assigned a heading of 0 degrees.</para>
+       <screen format="linespecific">
+       gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F -
+       </screen>
+
+       <para>SPEED</para>
+       <para>Course computes a value for the GPS speed at each trackpoint.
+       This is most useful with trackpoints from formats that don't support
+       speed information or for trackoints synthesized by the interpolate
+       filter.  The speed at each trackpoint is the average speed from the
+       previous trackpoint (distance/time).  The first trackpoint in each
+       track is assigned a speed of "unknown."</para>
+       <screen format="linespecific">
+       gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F -
+       </screen>
+
+      
index 8b137891791fe96927ad78e64b0aad7bded08bdc..9df4086fda848c017f7426ab1c1920561ce73810 100644 (file)
@@ -1 +1,24 @@
-
+<para>
+This option is used along with the <option>stop</option> to discard 
+trackpoints that were recorded outside of a specific period of time.  
+This option specifies the beginning of the time period.
+</para>
+<para>
+If this option is not specified, the time period is assumed to begin at the
+dawn of time or January 1, 1970, whichever was later.  The time for this 
+option is expressed in UTC. 
+</para>
+<para>
+The value of this option must be in the form of YYYYMMDDHHMMSS, but it is
+not necessary to specify the smaller time units if they are not needed.  
+That is, if you only care about points logged between 10 AM and 6 PM on a
+given date, you need not specify the minutes or seconds.
+</para>
+<example id="ex_track_startstop">
+<title>Extracting a period of time with the track filter</title>
+<para>
+To get only the parts of a track that were mapped on 20 July 2005
+between 10 AM and 6 PM, use this command line:
+</para> 
+<screen format="linespecific">gpsbabel -t -i gpx -f in.gpx -x track,start=2005072010,stop=2005072018 -o gpx -F out.gpx </screen>
+</example>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..a86755aeb911e384e169c3abc699976c6752c3ae 100644 (file)
@@ -1 +1,15 @@
+<para>
+This option is used in conjunction with the <option>start</option> option to 
+discard all trackpoints outside of a given period of time.  This option 
+defines the end of the time period.
+</para>
+<para>
+If this option is not specified, the time period is assumed to end at the 
+end of civilization as we know it or the year 2038, whichever comes first.
+The time for this option is expressed in UTC.
+</para>
+<para>
+See the <option>start</option> option for the format of this value and an 
+example of usage.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..be578bd46c113613bfdbe6fd3393ab474371193d 100644 (file)
@@ -1 +1,10 @@
-
+<para> 
+This option specifies a title for tracks generated by the track filter.
+By default, the title of the new track is composed of the start time of 
+the track appended to this value.
+</para>
+<para>
+If this value contains a percent (%) character, it is treated as a format 
+string for the POSIX strftime function, allowing custom time-based 
+track names. 
+</para>
index 84405b9bad74f8e7972c74e9fdd128e55c2bc1bf..a193f903e05f5f7b0e908b7b7a6c4930c2f52660 100644 (file)
@@ -1,36 +1,78 @@
-
-         
-         <para> The polygon filter includes points if they are inside
-         of a polygon.  A polygon file looks like an arc file, except
-         that the arc it describes must be a closed cycle.  That is,
-         for a simple polygon, the first and last points must be the
-         same.  Here's a square:
+<para> 
+The polygon filter includes points if they are inside
+of a polygon.  A polygon file looks like an 
+<link linkend="filter_arc">arc</link> file, except
+that the arc it describes must be a closed cycle.  That is,
+for a simple polygon, the first and last points must be the
+same.  Here's a square:
+</para>
+<screen format="linespecific">
+# A square (not really) polygon
+41.0000       -85.0000
+41.0000       -86.0000
+42.0000       -86.0000
+42.0000       -85.0000
+41.0000       -85.0000
+</screen>
+<para> 
+Polygons may include islands and holes.  To include an
+island or a hole, just append it to the main polygon.
 </para>
-         <screen format="linespecific">
-          # A square (not really) polygon
-          41.0000       -85.0000
-          41.0000       -86.0000
-          42.0000       -86.0000
-          42.0000       -85.0000
-          41.0000       -85.0000
+<screen format="linespecific">
+# A square polygon with a triangular hole
+41.0000       -85.0000
+41.0000       -86.0000
+42.0000       -86.0000
+42.0000       -85.0000
+41.0000       -85.0000
+# The hole begins here
+41.5000       -85.5000
+41.6000       -85.5000
+41.6000       -85.6000
+41.5000       -85.5000
 </screen>
-         <para> Polygons may include islands and holes.  To specify an
-         island or a hole, just append it to the main polygon.
+<para>
+As with the arc filter, you define a polygon by
+giving the name of the file that contains it, using
+the <option>file</option> option.  
 </para>
-         <para> As with the arc filter, you specify a polygon by
-         specifying the name of the file that contains it, using
-         the file option.  You can also specify the exclude option,
-         which reverses the operation of the filter so that it only
-         includes points that are NOT in the polygon.
+<para> 
+Note that this filter currently will not work properly
+if your polygon contains one or both poles or if it spans the
+line of 180 degrees east or west longitude.
 </para>
-         <para> Note that this filter currently will not work properly
-         if your polygon contains one or both poles or if it spans the
-         line of 180 degrees east or west longitude.
+<example id="example_polygon_filter">
+<title>Using the polygon filter</title>
+<para> 
+Suppose you have a polygon file that defines the border of your county, 
+called mycounty.txt.  This command line will give you only the points 
+in your county:
 </para>
-         <para> For example, assume you have a polygon file that
-         defines the border of your county, called mycounty.txt.  This
-         command line will give you only the points in your county:
+<screen format="linespecific">gpsbabel -i geo -f 1.loc -x polygon,file=mycounty.txt -o mapsend -F 2.wpt</screen>
+</example>
+<example id="example_in_or_close_to">
+<title>Using the polygon and arc filters to find points in or nearly in a 
+polygon</title>
+<para>
+Because the polygon and <link linkend="filter_arc">arc</link> filters use
+the same file format, you can use them together to find all points that are
+"in or nearly in" a polygon.  This can be useful if your waypoints or the 
+boundaries of your polygon are not quite perfect, so you want to provide a 
+buffer zone around it in case there are points nearby that should be in the 
+polygon but aren't quite.
 </para>
-         <screen format="linespecific">        gpsbabel -i geo -f 1.loc -x polygon,file=mycounty.txt            \
--o mapsend -F 2.wpt</screen>
-      
+<screen>
+gpsbabel -i gpx -f points.gpx -x stack,push -x polygon,file=mycounty.txt 
+-x stack,swap -x arc,file=mycounty.txt,distance=1k -x stack,pop,append 
+-x duplicate,shortname -o gpx -F nearmycounty.gpx
+</screen>
+<para>
+This command makes a copy of the points, finds the ones that are in your
+your county, swaps that result with the copy of the original set of points,
+finds the ones from that set that are within 1 km of the border of the county, 
+puts the two lists together, and then filters out any points that appear twice
+(This step is necessary because points inside the county but near the county 
+line will be kept by both the polygon and the arc filter.)
+</para>
+</example>
+
index a80105fece2ce381b8ae33fd9f4a8718828a7913..13ff374a0fe8218a7d8257c36f545f52452d2baa 100644 (file)
@@ -1,20 +1,15 @@
+<para> 
+This filter removes points based on their proximity to each other.  A 
+point is removed if it is within the specified distance of a point that 
+has come before.
+</para>
 
-         
-         <para> The position filter is designed to remove points based
-         on their proximity to each other.  Distances can be passed on
-         the command line by passing the <parameter moreinfo="none">distance=XXX</parameter> option to the
-         filter.  Distance options may be expressed in feet
-         (<parameter moreinfo="none">distance=3f</parameter>) or
-         meters (<parameter moreinfo="none">distance=1m</parameter>).
-         The default is zero feet, essentially a duplicate position.
-         </para>
-         <example id="posn_to_suppress_close_points">
-            <title>Using position filter to suppress close points</title>
-            <screen format="linespecific">gpsbabel -i geo -f 1.loc -f 2.loc -x position,distance=1f    \
-         -o mapsend -F 3.wpt</screen>
-         </example>
-         <para> would remove multiple points that are within 1 foot of
-         each other, leaving just one.</para>
-         <para> You can also specify the "all" option, which would
-         remove all of the points rather than leaving one.</para>
+<example id="posn_to_suppress_close_points">
+<title>Using the position filter to suppress close points</title>
+<para>
+The following command removes multiple points that are within 
+one foot of each other, leaving just one.
+</para>
+<screen format="linespecific">gpsbabel -i geo -f 1.loc -f 2.loc -x position,distance=1f -o mapsend -F 3.wpt</screen>
+</example>
       
index eb474b7ec647b6d4cce6099e4cb6b7b6a5bd6f4c..da4ad375e438b3c61315e40ed3aedcadfa81ba55 100644 (file)
@@ -1,8 +1,5 @@
-
-         
-         <para> This simple filter allows you to alphabetize waypoints
-         by shortname or by description.  It has a special suboption
-         (gcid) to sort by geocaching.com waypoint ID's when the input
-         comes from a GPX file that has GC numbers in it.
+<para>
+This filter sorts waypoints into alphabetical order by the selected field.
+You must specify exactly one of the options.
 </para>
       
index 6db49a7908af520c9a2a6261efa0ceb6bca9ca97..cf6c394943e0f4d86880b621a8490152f0c65a30 100644 (file)
@@ -1,123 +1,8 @@
-
-         
-         <para> ( !!! This filter always drops empty tracks !!! )
-         </para>
-         <para>The track filter is a tool for manipulating track lists.  The
-following options are available:</para>
-         <para> TITLE</para>
-         <para> Gives the new track(s) a basic title. Basic means if
-         more than one track is created by filter the title will be
-         expanded with the date the new track. Special formats (see
-         UNIX date or strftime for details) are possible.
+<para>
+WARNING: This filter always drops empty tracks.
 </para>
-         <screen format="linespecific">
-gpsbabel -t \
- -i gpx -f in.gpx \ -x track,pack,split,title="ACTIVE LOG-%D" \ 
--o gpx -F out.gpx PACK
-       </screen>
-         <para>MOVE</para>
-         <para>Change the time of all trackpoints. This is useful if
-         your track has moved by one or more hours through a time zone
-         problem.  The following example will shift your track to be
-         one hour later.</para>
-         <screen format="linespecific">            
-gpsbabel -t  -i gpx -f in.gpx  \
-    -x track,move=+1h,pack,title="ACTIVE LOG"  \
-    -o gpx -F out.gpx  </screen>
-         <para> START / STOP </para>
-         <para>Filter tracks against time borders. All points outside
-         this range will be dropped. The date-time paramters have to
-         be in form of YYYYMMDDHHMMSS; but you may specify only the
-         most significant portion represented in the the leftmost
-         fields.  See the example, where the time is specified only
-         through the hour.  If you only want to get a track mapped on
-         20 july 2005 from 10 am to 6pm, you should use this: </para>
-         <screen format="linespecific">
-gpsbabel -t -i gpx -f in.gpx -x \
-      track,start=2005072010,stop=2005072018 \
-      -o gpx -F out.gpx </screen>
-         <para>PACK</para>
-         <para> With this default option all tracks from input will be
-         packed into one track. If tracks overlaps in time, the filter
-         stops working.  To pack all the tracks together into one
-         track and give it a name, use this:</para>
-         <screen format="linespecific">            
-gpsbabel -t  -i gpx -f in.gpx          -x track,pack,title="ACTIVE LOG"  \
-                    -o gpx -F out.gpx  </screen>
-         <para>SPLIT </para>
-         <para> The input track will be split into several tracks
-         depending on date of track points. If there is more than one
-         track, use the pack option before before using this.  To
-         split a single tracks into separate tracks for each day and
-         name them, use this:
-      </para>
-         <screen format="linespecific">
-gpsbabel -t -i gpx -f in.gpx -x \
-   track,split,title="ACTIVE LOG \
-    # %Y%m%d" -o gpx -F out.gpx</screen>
-         <para> If the input has multiple tracks, pack them together before
-splitting them back apart per day thusly: </para>
-         <screen format="linespecific">            
-gpsbabel -t   -i gpx -f in.gpx  \
-     -x track,pack,split,title="ACTIVE LOG # %D"       \
-     -o gpx -F out.gpx</screen>
-         <para> Additionally you can add an interval to the split
-         option.  With this the track will be split if the time
-         between two points is greater than this parameter. The
-         interval must be numeric and can be int days, hours, minutes
-         or seconds, expressed as one of the character "d", "h", "m",
-         or "s".  If no trailing character is present, the units are
-         assumed to be in seconds.
+<para>
+This filter performs various operations on track data.
 </para>
-         <para> For example, to split a track based on an four hour
-         interval, use this:</para>
-         <screen format="linespecific">            
-gpsbabel -t \ 
-     -i gpx -f in.gpx \ 
-     -x track,pack,split=4h,title="LOG # %c" \ 
-     -o gpx -F out.gpx
-</screen>
-         <para> MERGE</para>
-         <para> Merge puts all track points into one single track and
-         sort them by time. Points with identical time stamp will be
-         dropped !!!</para>
-         <para> If you want to merge tracks from different devices but
-         from same trip, use this:</para>
-         <screen format="linespecific">
-gpsbabel -t \
-     -i gpx -f john.gpx \
-     -i gpx -f doe.gpx \
-     -x track,merge,title="COMBINED LOG" \
-     -o gpx -F john_doe.gpx
-</screen>
-       <para>FIX</para>
-       <para>Fix forces the GPS fix status for all trackpoints to the 
-        specified value.  The value may be PPS, DGPS, 3D, 2D, or NONE.
-       </para>
-       <screen format="linespecific">
-       gpsbabel -i gpx -f trk.gpx -x track,fix=3D -o nmea -F -
-       </screen>
-
-       <para>COURSE</para>
-       <para>Course computes a value for the GPS heading at each trackpoint.
-       This is most useful with trackpoints from formats that don't support
-       heading information or for trackpoints synthesized by the interpolate
-       filter.  The heading at each trackpoint is simply the course from the
-       previous trackpoint in the track.  The first trackpoint in each track
-        is arbitrarily assigned a heading of 0 degrees.</para>
-       <screen format="linespecific">
-       gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F -
-       </screen>
-
-       <para>SPEED</para>
-       <para>Course computes a value for the GPS speed at each trackpoint.
-       This is most useful with trackpoints from formats that don't support
-       speed information or for trackoints synthesized by the interpolate
-       filter.  The speed at each trackpoint is the average speed from the
-       previous trackpoint (distance/time).  The first trackpoint in each
-       track is assigned a speed of "unknown."</para>
-       <screen format="linespecific">
-       gpsbabel -i gpx -f trk.gpx -x track,course,speed -o nmea -F -
-       </screen>
 
       
index 2fbc65076e00ba2e93c4e3c632785f76a179b1fc..8cf7a3f812ac91178c80fd9b31521b07bfdabc27 100644 (file)
@@ -4,39 +4,48 @@ allows you to change the types of roads based on their names.  You can
 change multiple roads at the same time.  Currently supported types are 
 </para>
 
-      <simplelist type="vert">
-        <member>
-               <parameter moreinfo="none">limited</parameter>
-               Limited-access freeways</member>
-        <member>
-               <parameter moreinfo="none">toll</parameter>
-               Limited-access toll highways</member>
-        <member>
-               <parameter moreinfo="none">ramp</parameter>      
-               Access ramps for limited-access highways</member>
-        <member>
-               <parameter moreinfo="none">us</parameter> 
-               National highways (e.g. US routes)</member>
-        <member>
-               <parameter moreinfo="none">primary</parameter> 
-               Primary State/Provincial routes</member>
-        <member>
-               <parameter moreinfo="none">state</parameter>
-               State/Provincial routes</member>
-        <member>
-               <parameter moreinfo="none">major</parameter>     
-               Major Connectors</member>
-        <member>
-               <parameter moreinfo="none">ferry</parameter>     
-               Ferry Routes</member>
-        <member>
-               <parameter moreinfo="none">local</parameter>     
-               Local Roads</member>
-        <member>
-               <parameter moreinfo="none">editable</parameter>
-               User-drawn Roads
-       </member>
-      </simplelist>
+      <variablelist termlength="20">
+        <varlistentry>
+               <term>limited</term>
+              <listitem><simpara>Limited-access freeways</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>toll</term>
+               <listitem><simpara>Limited-access toll highways</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>ramp</term>      
+               <listitem><simpara>Access ramps for limited-access highways</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>us</term> 
+               <listitem><simpara>National highways (e.g. US routes)</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>primary</term> 
+               <listitem><simpara>Primary State/Provincial routes</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>state</term>
+               <listitem><simpara>State/Provincial routes</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>major</term>     
+               <listitem><simpara>Major Connectors</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>ferry</term>     
+               <listitem><simpara>Ferry Routes</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>local</term>     
+               <listitem><simpara>Local Roads</simpara></listitem>
+        </varlistentry>
+        <varlistentry>
+               <term>editable</term>
+               <listitem><simpara>User-drawn Roads</simpara></listitem>
+        </varlistentry>
+      </variablelist>
 
 <para>
 GPSBabel defaults to creating editable roads.  These are routed just like